Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: receive XBlock visibility from the Learning MFE #35491

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: receive XBlock visibility from the Learning MFE #35491

wants to merge 1 commit into from
+44 −2

Conversation

Agrendalath
Copy link
Member

@Agrendalath Agrendalath commented Sep 16, 2024 •
edited
Loading

Description

Currently, the LMS retrieves the viewport information with getBoundingClientRect. However, it doesn't work correctly when the XBlocks are rendered in an iframe because the iframe is automatically resized to its full height.

This solves the described problem by sending the visibility status from the Learning MFE to the LMS.

Testing instructions:

  1. (Optional) Set COMPLETION_BY_VIEWING_DELAY_MS = 1000 in lms/envs/private.py for easier testing. The default value is 5000.
  2. (Optional) Change publish_completion to publish_completions in lms/static/completion/js/CompletionOnViewService.js for easier testing. Otherwise, you will need to create a new XBlock for the next check or manually remove the BlockCompletion object from the DB to get the API call re-triggered the next time you view it.
  3. Check out the current PR and fix: send XBlock visibility status to the LMS frontend-app-learning#1491.
  4. Create an HTML block with a single line. Check that the publish_completion request is called in both the Learning MFE and the Preview (to check for regressions).
  5. Create two HTML blocks with enough lines to exceed your viewport. Check that the publish_completion request is called when you scroll down to the bottom of each of these blocks (in the Learning MFE and Preview).

Deadline

"None"

Other information

Ported from open-craft#662.

Private-ref: BB-8826

@Agrendalath Agrendalath self-assigned this Sep 16, 2024
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Sep 16, 2024
@openedx-webhooks
Copy link

openedx-webhooks commented Sep 16, 2024 •
edited
Loading

Thanks for the pull request, @Agrendalath!

What's next?

Please work through the following steps to get your changes ready for engineering review:

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/wg-maintenance-edx-platform. Tag them in a comment and let them know that your changes are ready for review.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

This was referenced Sep 25, 2024
Open
Open
@Agrendalath Agrendalath marked this pull request as ready for review September 25, 2024 18:04
@Agrendalath Agrendalath force-pushed the agrendalath/bb-8826-completion-in-the-learning-mfe-upstream branch from 35b2276 to dbd60f6 Compare September 25, 2024 18:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@farhaanbukhsh farhaanbukhsh Awaiting requested review from farhaanbukhsh

At least 1 approving review is required to merge this pull request.

Assignees

@Agrendalath Agrendalath

Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Contributions
Status: Waiting on Author
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Agrendalath @openedx-webhooks